IMotion.UngroupAllAxes method

Removes all axes from a group. The command cannot be buffered. After finalization the state is changed to GroupDisabled.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError UngroupAllAxes(
       int Index
)

Function UngroupAllAxes(
       Index As Integer
) As KsError

Parameters

Index [in]

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

Return value

A return code of a method.

Remarks

If sent to a group that is not in GroupDisabled, GroupStandstill, or GroupErrorStop, it generates an error and the method is not executed.

Examples

N/A